[Snyk] Upgrade typedoc from 0.26.11 to 0.28.8 #39
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Snyk has created this PR to upgrade typedoc from 0.26.11 to 0.28.8.
ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
The recommended version is 25 versions ahead of your current version.
The recommended version was released 23 days ago.
Release notes
Package name: typedoc
-
0.28.8 - 2025-07-28
- If using JS config files, the
- Permit
- Exposed
- Relative links in
- Relative links in
- Improved inherited from/overwrites link discovery to point to parent properties in more cases, #2978
- @ jonathanhefner
- @ laymonage
-
0.28.7 - 2025-06-30
- Introduced the
- Classes and functions exported with
- Setting
- Array options will now report an error if set to a non-array/non-string value.
-
0.28.6 - 2025-06-27
- TypeDoc now supports resolving relative paths in links to the package directory as belonging to the project, #2961.
- Declarations without comments will now check for comments on their export specifier, #2964.
- Attempting to highlight a supported language which is not enabled is now a warning, not an error, #2956.
- Improved compatibility with CommonMark's link parsing, #2959.
- Classes, variables, and functions exported with
- Improved warning messaging for links to symbols which were resolved, but the symbols were not included in the documentation, #2967.
- Fixed an issue preventing nested documents from being deserialized from TypeDoc's JSON output or used in packages mode, #2969.
- @ yGuy
-
0.28.5 - 2025-05-26
- References to type aliases defined as mapped types will now correctly create a reference to the type alias, #2954.
-
0.28.4 - 2025-05-04
- The navigation in the default theme will now attempt to break long names onto multiple lines, #2940.
- Added German (de) localization, #2941.
- TypeDoc's default theme now uses the same chevron for all collapsible elements, #2924
- Classes/interfaces marked with
- TypeDoc now handles wildcard JSDoc types, #2949.
- @ blutorange
- @ bkeepers
-
0.28.3 - 2025-04-20
- Aliased symbols (re-exports) are now resolved before checking if they are excluded/external, #2937.
- Improved error reporting when paths including Windows separators are provided as globs, #2938.
-
0.28.2 - 2025-04-07
- Added
- Variables using
- Variables using
- Variables using
- When printing entry point globs which fail to match any paths, TypeDoc will no longer normalize the glob, #2918.
- Inlining types can now handle more type variants, #2920.
- Fixed behavior of
- Fixed broken links within module pages when structure-dir router was used, #2928.
- Type parameters on JS classes defined with
- API:
- Added
-
0.28.1 - 2025-03-20
- The
- API: Expose control methods for deferred conversion for plugin use (typedoc-plugin-missing-exports)
- API: Expose method to disable TypeDoc usage of
- Generated page names now correctly handles UTF-8 characters requiring more than 16 bits #2905.
- Fixed a crash when converting
- Fixed URL generation which introduced a superfluous
- @ jsmith2-coveo
- @ romainmnr
-
0.28.0 - 2025-03-15
- TypeDoc now expects all input globs paths to be specified with
- TypeDoc's
- Removed
- File name references in
- The
- TypeDoc will only check for a project README file next to the discovered
- Function-like variable exports will now only be automatically converted as function types if
- Object literal type alias types will now be converted in a way which causes them to be rendered more similarly
- Introduced a
- Removed
- The HTML output structure for the search box has changed to support the new modal.
- Add support for TypeScript 5.8.x
- The search modal in the HTML output has been rewritten to provide better mobile support
- Added a
- Introduced the
- Introduced
- TypeDoc now exports a
- Type
- TypeDoc will now warn if an option which should only be set at the root level is set in
- Introduced
- Exposed a
- Introduced
- Introduced
- API: Introduced
- TypeDoc will now only create references for symbols re-exported from modules.
- Variable-functions will now prefer placing the comment on the signature if there is only one signature present, #2824.
- User filter settings will no longer sometimes cause the search to have fewer visible results than expected.
- Fixed handling of expando functions which were also merged with a namespace, #2876.
- Fixed rendering of function types within arrays and union types, #2892.
- Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, #2894.
- @ crimx
- @ jsmith2-coveo
- @ phoneticallySAARTHaK
- @ XeroAlpha
-
0.28.0-beta.2 - 2025-03-10
-
0.28.0-beta.1 - 2025-03-01
-
0.28.0-beta.0 - 2025-02-23
-
0.27.9 - 2025-02-25
-
0.27.8 - 2025-02-21
-
0.27.7 - 2025-02-09
-
0.27.6 - 2024-12-26
-
0.27.5 - 2024-12-14
-
0.27.4 - 2024-12-09
-
0.27.3 - 2024-12-04
-
0.27.2 - 2024-11-29
-
0.27.1 - 2024-11-28
-
0.27.0 - 2024-11-27
-
0.27.0-beta.2 - 2024-11-25
-
0.27.0-beta.1 - 2024-11-23
-
0.27.0-beta.0 - 2024-11-04
-
0.26.11 - 2024-11-01
from typedoc GitHub release notesFeatures
pluginoption can now be given plugin functions to load.-within tag names to supporttypescript-json-schema's@ TJS-typetag, #2972.Context.createSymbolIdfor use by plugins.Bug Fixes
<img srcset>will now be discovered by TypeDoc, #2975.<source src>and<source srcset>elements will now be discovered by TypeDoc, #2975.Thanks!
Features
@ sortStrategytag to override thesortoption on a specific reflection, #2965.Bug Fixes
export { type X }are no longer missing comments, #2970.localeto an unknown value will now cause TypeDoc to operate in English instead of a debug locale.Features
Bug Fixes
export { type X }are now detected and converted as interfaces/type aliases, #2962.Thanks!
Bug Fixes
ignoredHighlightLanguagescan now be used to prevent warnings for codeblocks containing languageswhich are supported by Shiki but are not loaded, #2956.
Features
Bug Fixes
The
chevronSmallhelper is now deprecated and will be removed with v0.29.0.@ hiddenwill no longer appear in the"Hierarchy" section of the docs.
Thanks!
Bug Fixes
@ inlinenow functions when referencing tuple types, #2932.@ linklinks to the current page are now rendered, #2934.@ includeCodenow supports regions in TypeScript files with.mtsand.ctsfile extensions, #2935.Features
@ group noneand@ category nonewill now render their children without a sectionheading in the default theme, #2922.
@ disableGroupstag to completely disable the grouping mechanism for agiven reflection, #2922.
Bug Fixes
@ classnow correctly handle@ category, #2914.@ classnow include constructor parameters, #2914.@ classwith a generic first constructor function now adoptthat function's type parameters as the class type parameters, #2914.
externalSymbolLinkMappingsoption when URL is set to#, #2921.@ typedefnow correctly handle the constraint, #2929.toStringon types containing index signatures now behave correctly, #2917.@ inlineTypeto the list of tags excluded by default.Features
TypeDocOptionsinterface now marks options as optional so it no longer has to be wrapped inPartialfor use in config files, #2901.
localStoragewithout clearing it, #2908.Bug Fixes
--watchcan now infer entry points frompackage.jsonas supported in non-watch mode, #2899.@ includewith regions now works on files with CRLF line endings, #2902.module.exports = [], #2909../in relative links, #2910.Thanks!
Breaking Changes
/path separators, #2825.--entryPointStrategy mergemode now requires JSON from at least version 0.28.0.jptranslations fromlang, to migrate switch toja.intentionallyNotExportednow use a package name/package relative path instead of an absolute path for matching.source-ordersort ordering now considers package names / package relative paths instead of using the absolute paths to a file.package.jsonfile if--readmeis not setthis change improves handling of monorepo setups where some packages have readme files and others do not, #2875.
they are initialized with a function expression. TypeDoc can be instructed to convert them as functions
with the
@ functiontag, #2881.to how interfaces are rendered, #2817.
API Breaking Changes
ProjectReflection.getReflectionFromSymbolandProjectReflection.getSymbolFromReflectionhave been moved toContextPathandPathArrayparameter types now always contain normalized paths.Routerwhich is used for URL creation.Reflection.url,Reflection.anchor, andReflection.hasOwnDocumenthave been removed.Deserializer.reviveProject(s)no longer accepts an option to add project documents.Deserializer.reviveProjectsnow requires analwaysCreateEntryPointModuleoption.Comment.serializeDisplayPartsno longer requires a serializer argument.ReflectionSymbolId.fileNameis now optional, TypeDoc now stores a combination of a package name and package relative path instead.The
fileNameproperty will be present when initially created, but is not serialized.DeclarationReflection.relevanceBoostattribute which was added for plugins, but never used.i18nproxy is no longer passed to many functions, instead, referencei18nexported from the module directly.ReflectionKind.singularStringandReflectionKind.pluralStringnow returns translated strings.The methods on
Internationalizationto do this previously have been removed.DefaultThemeRenderContext'stypeDeclarationandtypeDetailsIfUsefulmethods now require both a reflection and a type in order to support
@ expandTypeFeatures
--routeroption which can be used to modify TypeDoc's output folderstructure. This can be extended with plugins, #2111.
@ primaryExportmodifier tag to provide more fine grainedcontrol over export conversion order, #2856
packagesRequiringDocumentationoption forvalidation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.typedoc/browserentrypoint for parsing and using serialized JSON files, #2528.packageOptionsasPartial<TypeDocOptions>, #2878.packageOptions, #2878.@ functiontag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.TypeDocglobal object in the HTML theme which can be used to prevent TypeDoc from usinglocalStorage, #2872.@ preventInlineand@ inlineTypetags for further control extending the@ inlinetag, #2862.@ preventExpandand@ expandTypetags for further control extending the@ expandtag, #2862.DefaultThemeRenderContext.reflectionIconfor more granular control over displayed reflection icons.Bug Fixes
Thanks!
See #2868 (comment) for discussion of changes
Important
Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.
For more information: